feat: expose JobFailedException and JobCancelledException at TSC top level - #1870
Open
jacalata wants to merge 2 commits into
Open
feat: expose JobFailedException and JobCancelledException at TSC top level#1870jacalata wants to merge 2 commits into
jacalata wants to merge 2 commits into
Conversation
…level Both were previously reachable only via `tableauserverclient.server.endpoint.exceptions`, which is an internal module path. Callers waiting on a background job with `server.jobs.wait_for_job()` need to catch these to distinguish a failed job from a cancelled one (JobCancelledException is a subclass of JobFailedException, so the order in an except-chain matters), and reaching into a `server.endpoint` sub-package to do so is a bad pattern to teach. Re-export them alongside the other exception types already exposed at the top level (FailedSignInError, MissingRequiredFieldError, NotSignedInError, ServerResponseError). Existing internal imports in tests and endpoints remain unchanged; this is purely additive. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
🟢 Approval recommended
The change is purely additive and consistently updates both the import surface and __all__ exports needed for the new public API.
Pull request overview
Exposes JobFailedException and JobCancelledException as part of the public TSC top-level API so callers using server.jobs.wait_for_job() can catch these exceptions without importing from an internal server.endpoint path.
Changes:
- Re-export
JobFailedException/JobCancelledExceptionfromtableauserverclient.server(and include them inserver.__all__). - Re-export the same exceptions from the package top level
tableauserverclient(and include them inTSC.__all__).
File summaries
| File | Description |
|---|---|
| tableauserverclient/server/init.py | Adds JobFailedException / JobCancelledException to server-level imports and __all__ for public export. |
| tableauserverclient/init.py | Adds JobFailedException / JobCancelledException to top-level imports and __all__ so they’re available as TSC.*. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…op level Same shape and same private-path problem as the Job exceptions this PR is already fixing. flow_runs.wait_for_flow_run() raises these; users need to catch them without importing from server.endpoint.exceptions. Add regression tests for both pairs so a future refactor of __init__.py can't silently break the public surface. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Neither the
Job*exceptions raised byserver.jobs.wait_for_job()nor theFlowRun*exceptions raised byserver.flow_runs.wait_for_flow_run()are reachable from the top-level TSC namespace today — callers have to import fromtableauserverclient.server.endpoint.exceptions, an internal module path. Reaching into aserver.endpointsub-package to catch a public failure signal is a bad pattern to teach.Behavior change
TSC.JobFailedException,TSC.JobCancelledException,TSC.FlowRunFailedException, andTSC.FlowRunCancelledExceptionare now importable, alongsideFailedSignInError,MissingRequiredFieldError,NotSignedInError, andServerResponseError.JobCancelledExceptionremains a subclass ofJobFailedException, andFlowRunCancelledExceptiona subclass ofFlowRunFailedException. Broadexcept JobFailedExceptionandexcept FlowRunFailedExceptioncontinue to catch both variants; code that wants to differentiate should catch theCancelledvariant first.test/test_import_surface.pyguards all four names against silent regression of__init__.py.Test plan
python -c "import tableauserverclient as TSC; assert issubclass(TSC.JobCancelledException, TSC.JobFailedException); assert issubclass(TSC.FlowRunCancelledException, TSC.FlowRunFailedException)"— passes.TSC.__all__.pytest test/test_import_surface.py— new tests pass.Followup
samples/list_jobs.py(added in #1843) currently reaches into the internal path. Once #1843 merges, a one-line followup PR will switch it to the top-level import.🤖 Generated with Claude Code